
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-lifecycle-module</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-lifecycle-module</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-jvm-options.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-local-instance.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-lifecycle-module-1"></a><a id="GSRFM00043"></a><a id="create-lifecycle-module"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_lifecycle_module">create-lifecycle-module</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a lifecycle module</p>
</div>
<div id="sthref380" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-lifecycle-module [--help]
--classname classname
[--enabled={true|false}] [--target target]
[--classpath classpath] [--loadorder loadorder]
[--failurefatal={false|true} ] [--description description]
[--property (name=value)[:name=value]*]
module_name</code></pre>
</div>
</div>
<div id="sthref381" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>create-lifecycle-module</code> subcommand creates a lifecycle module. A
lifecycle module provides a means of running a short or long duration
Java-based task at a specific stage in the server life cycle. This
subcommand is supported in remote mode only.</p>
</div>
<div id="sthref382" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--classname</code></dt>
<dd>
<p>This is the fully qualified name of the startup class.</p>
</dd>
<dt class="hdlist1"><code>--target</code></dt>
<dd>
<p>Indicates the location where the lifecycle module is to be created.
Valid values are<br></p>
<div class="ulist">
<ul>
<li>
<p><code>server</code>- Specifies the default server instance as the target for
creating the lifecycle module. <code>server</code> is the name of the default
server instance and is the default value for this option.</p>
</li>
<li>
<p>cluster_name- Specifies a particular cluster as the target for
creating the lifecycle module.</p>
</li>
<li>
<p>instance_name- Specifies a particular stand-alone server instance as
the target for creating the lifecycle module.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1"><code>--classpath</code></dt>
<dd>
<p>This option indicates where the lifecycle module is located. It is a
classpath with the standard format: either colon-separated (Unix) or
semicolon-separated (Windows) JAR files and directories. The
referenced JAR files and directories are not uploaded to the server
instance.</p>
</dd>
<dt class="hdlist1"><code>--loadorder</code></dt>
<dd>
<p>This option represents an integer value that can be used to force the
order in which deployed lifecycle modules are loaded at server
startup. Smaller numbered modules are loaded sooner. Order is
unspecified if two or more lifecycle modules have the same load-order
value. The default is <code>Integer.MAX_VALUE</code>, which means the lifecycle
module is loaded last.</p>
</dd>
<dt class="hdlist1"><code>--failurefatal</code></dt>
<dd>
<p>This option tells the system what to do if the lifecycle module does
not load correctly. When this option is set to true, the system aborts
the server startup if this module does not load properly. The default
value is false.</p>
</dd>
<dt class="hdlist1"><code>--enabled</code></dt>
<dd>
<p>This option determines whether the lifecycle module is enabled at
runtime. The default value is true.</p>
</dd>
<dt class="hdlist1"><code>--description</code></dt>
<dd>
<p>This is the text description of the lifecycle module.</p>
</dd>
<dt class="hdlist1"><code>--property</code></dt>
<dd>
<p>This is an optional attribute containing name/value pairs used to
configure the lifecycle module.</p>
</dd>
</dl>
</div>
<div id="sthref383" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">module_name</dt>
<dd>
<p>This operand is a unique identifier for the deployed server lifecycle
event listener module.</p>
</dd>
</dl>
</div>
<div id="sthref384" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM504"></a><a id="sthref385"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a Lifecycle Module</p>
</div>
<div class="paragraph">
<p>The following example creates a lifecycle module named <code>customSetup</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-lifecycle-module --classname "com.acme.CustomSetup"
--classpath "/export/customSetup" --loadorder 1 --failurefatal=true
--description "this is a sample customSetup"
--property rmi="Server\=acme1\:7070":timeout=30 customSetup
Command create-lifecycle-module executed successfully</code></pre>
</div>
</div>
<div class="paragraph">
<p>The escape character <code>\</code> is used in the property option to specify that
the equal sign (=) and colon (:) are part of the <code>rmi</code> property value.</p>
</div>
<div id="sthref386" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref387" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="delete-lifecycle-module.html#delete-lifecycle-module-1"><code>delete-lifecycle-module</code>(1)</a>,
<a href="list-lifecycle-modules.html#list-lifecycle-modules-1"><code>list-lifecycle-modules</code>(1)</a></p>
</div>
<div class="paragraph">
<p>"<a href="../application-development-guide/lifecycle-listeners.html#GSDVG00014">Developing Lifecycle Listeners</a>" in Payara Server
Open Source Edition Application Development Guide</p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-jvm-options.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-local-instance.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
